Buffer

MSLUBufferCreate

• Syntax:

  double MSLUBufferCreate(double Window, double Interval);
  

  Window: Size of moving window.
  Interval: Interval after which new data point is added to buffer.

• Description:

  Create new buffer with a moving window of size "Window". The window applies to all operation performed on the buffer, except for the MSLUBufferGetMeanTotal, MSLUBufferGetStdDevTotal and MSLUBufferGetIntTotal functions. Set the window size to 0 in case no window is to be applied.

• Returns:

  Unique identifier referring to the newly created buffer.

MSLUBufferReset

• Syntax:

  double MSLUBufferReset(double ID);
  

  ID: Buffer identifier.
  

• Description:

  Reset buffer.

• Returns:

  0.

MSLUBufferLoad

• Syntax:

  double MSLUBufferLoad(double FileID);
  

  FileID: ID of the data file that is to be loaded.

• Description:

  Create new buffer and load data file into it. The file that is loaded is "MSLUBuffer.<FileID>.txt". No window is applied for the newly created buffer.

• Returns:

  Unique identifier referring to the newly created buffer.

MSLUBufferWrite

• Syntax:

  double MSLUBufferWrite(double ID, double FileID);
  

  ID: Buffer identifier. FileID: ID of the data file that is to be written.

• Description:

  Write buffer contents to a file named "MSLUBuffer.<FileID>.txt".

• Returns:

  Always returns 0.

MSLUBufferRemove

• Syntax:

  double MSLUBufferRemove(double ID);
  

  ID: Buffer identifier.

• Description:

  Remove buffer.

• Returns:

  Always returns 0.

MSLUBufferRemoveAll

• Syntax:

  double MSLUBufferRemoveAll(void);
  

• Description:

  Remove all buffers.

• Returns:

  Always returns 0.

MSLUBufferPut

• Syntax:

  double MSLUBufferPut(double ID, double X, double Y);
  

  ID: Buffer identifier.
  X: X-value of data point.
  Y: Y-value of data point.

• Description:

  Add new data point to buffer.

• Returns:

  Always returns 0.

MSLUBufferGet

• Syntax:

  double MSLUBufferGet(double ID, double X);
  

  ID: Buffer identifier.
  X: X-value of data point.

• Description:

  Get Y-value of data point that has an X-value of "X", using linear interpolation.

• Returns:

  Y-value.

MSLUBufferGetMin

• Syntax:

  double MSLUBufferGetMin(double ID);
  

  ID: Buffer identifier.

• Description:

  Get lowest Y-value of all data points in the buffer.

• Returns:

  Minimum value.

MSLUBufferGetMax

• Syntax:

  double MSLUBufferGetMax(double ID);
  

  ID: Buffer identifier.

• Description:

  Get highest Y-value of all data points in the buffer.

• Returns:

  Maximum value.

MSLUBufferGetMean

• Syntax:

  double MSLUBufferGetMean(double ID);
  

  ID: Buffer identifier.

• Description:

  Get mean (weighted by the X-values) of data points in the buffer.

• Returns:

  Weighted mean.

MSLUBufferGetMeanTotal

• Syntax:

  double MSLUBufferGetMeanTotal(double ID);
  

  ID: Buffer identifier.

• Description:

  Get mean (weighted by the X-values) of data points in the buffer, irrespective of the window.

• Returns:

  Weighted mean.

MSLUBufferGetStdDev

• Syntax:

  double MSLUBufferGetStdDev(double ID);
  

  ID: Buffer identifier.

• Description:

  Get standard deviation (weighted by the X-values) of data points in the buffer.

• Returns:

  Weighted standard deviation.

MSLUBufferGetStdDevTotal

• Syntax:

  double MSLUBufferGetStdDevTotal(double ID);
  

  ID: Buffer identifier.

• Description:

  Get standard deviation (weighted by the X-values) of data points in the buffer, irrespective of the window.

• Returns:

  Weighted standard deviation.

MSLUBufferGetInt

• Syntax:

  double MSLUBufferGetInt(double ID);
  

  ID: Buffer identifier.

• Description:

  Get integral of data points in the buffer.

• Returns:

  Integral.

MSLUBufferGetIntTotal

• Syntax:

  double MSLUBufferGetIntTotal(double ID);
  

  ID: Buffer identifier.

• Description:

  Get integral of data points in the buffer, irrespective of the window.

• Returns:

  Integral.

MSLUBufferGetPercentile

• Syntax:

  double MSLUBufferGetPercentile(double ID, double Percentage);
  

  ID: Buffer identifier.
  Percentage: Percentage for percentile computation.

• Description:

  Get "Percentage"-th percentile of data points in the buffer.

• Returns:

  Percentile.

MSLUBufferGetNoLowerBoundViolations

• Syntax:

  double MSLUBufferGetNoLowerBoundViolations(double ID, double LowerBound);
  

  ID: Buffer identifier.
  LowerBound: Lower bound.

• Description:

  Get the number of violations of "LowerBound";

• Returns:

  Number of violations.

MSLUBufferGetNoUpperBoundViolations

• Syntax:

  double MSLUBufferGetNoUpperBoundViolations(double ID, double UpperBound);
  

  ID: Buffer identifier.
  UpperBound: Upper bound.

• Description:

  Get the number of violations of "UpperBound".

• Returns:

  Number of violations.

MSLUBufferGetPercentageLowerBoundViolation

• Syntax:

  double MSLUBufferGetPercentageLowerBoundViolation(double ID, double LowerBound);
  

  ID: Buffer identifier.
  LowerBound: Lower bound.

• Description:

  Get the percentage of time in violation of "LowerBound".

• Returns:

  Percentage of time in violation.

MSLUBufferGetPercentageUpperBoundViolation

• Syntax:

  double MSLUBufferGetPercentageUpperBoundViolation(double ID, double UpperBound);
  

  ID: Buffer identifier.
  UpperBound: Upper bound.

• Description:

  Get the percentage of time in violation of "UpperBound".

• Returns:

  Percentage of time in violation.

MSLUBufferGetDeriv

• Syntax:

  double MSLUBufferGetDeriv(double ID);
  

  ID: Buffer identifier.

• Description:

  Get derivative.

• Returns:

  Derivative.

MSLUBufferGetSumX

• Syntax:

  double MSLUBufferGetSumX(double ID);
  

  ID: Buffer identifier.

• Description:

  Get sum of X-values of data points in the buffer.

• Returns:

  Sum of X-values.

MSLUBufferGetSumY

• Syntax:

  double MSLUBufferGetSumY(double ID);
  

  ID: Buffer identifier.

• Description:

  Get sum of Y-values of data points in the buffer.

MSLUBufferGetSlope

• Syntax:

  double MSLUBufferGetSlope(double ID);
  

  ID: Buffer identifier.

• Description:

  Get slope of regression curve of the linear regression analysis.

• Returns:

  Slope of the regression curve.

MSLUBufferGetIntercept

• Syntax:

  double MSLUBufferGetIntercept(double ID);
  

  ID: Buffer identifier.

• Description:

  Get intercept of regression curve with the X-axis in the linear regression analysis.

• Returns:

  Intercept with X-axis of the regression curve.